/**
 * 
 */
package org.rk.core.common.anno.docAnno;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * @author Cavion(曹仁道)
 * @类描述：api文档注解
 * 2016年12月23日
 */
@Documented
@Target({ElementType.TYPE,ElementType.METHOD,ElementType.FIELD })
@Retention(RetentionPolicy.RUNTIME)
public @interface ApiDocAnno {
	/**
	 * @方法描述：名称
	 * @author:Cavion(曹仁道)
	 * @return
	 * 2016年12月22日
	 */
	String name() default "";
	/**
	 * @方法描述：描述
	 * @author:Cavion(曹仁道)
	 * @return
	 * 2016年12月22日
	 */
	String desc() default "";
	/**
	 * @方法描述：是否必须，作为参数时有效
	 * @author:Cavion(曹仁道)
	 * @return
	 * 2016年12月23日
	 */
	boolean isMust() default false;
	/**
	 * @方法描述：注解的api类型，包含类，方法，参数，属性
	 * @author:Cavion(曹仁道)
	 * @return
	 * 2016年12月23日
	 */
	DocType docType();

}
